Release 10.1A: OpenEdge Development:
Progress Dynamics Managers API Reference

calculateObjectPaths

This procedure is the standard mechanism for finding the paths associated with an object or product module. Use this procedure to calculate relative paths for new objects, existing objects, and associated files for objects, such as a DynSDO’s include file.

If an object name is supplied, the procedure looks for its ryc_smartobject.smartobject_obj value. If the smartobject_obj value is known, the object name is not needed. For general path enquiries on a product module, only the product module name is needed.

Location: ry\app\ryrepmngrp.i

Parameters:

INPUT pcObjectName AS CHARACTER

The name of the object to be parsed.

INPUT pcObjectObj AS DECIMAL

The smartobject_obj of the object being parsed.

INPUT pcObjectType AS CHARACTER

The gsc_object_type.object_type_code for the object. (optional)

INPUT pcProductModule AS CHARACTER

The name of the product module for the object being parsed. This must be a valid gsc_product_module.product_module_code value. If a valid object name or smartobject_obj is passed in, the product module under which the object is registered is used instead of any passed-in value. If only the product module is passed in, the relative path information for the product module is returned.

INPUT pcObjectparameter AS CHARACTER

This field is normally left blank for parsing objects directly. If set to "include", the procedure calculates the filename for an include file associated with the object being parsed. If set to "clientProxy", the procedure calculates the _cl client proxy filename for the object being parsed.

INPUT pcNameSpace AS CHARACTER

Reserved for future use.

OUTPUT pcRootDirectory AS CHARACTER

The calculated root directory for the current session.

OUTPUT pcRelativeDirectory AS CHARACTER

The calculated relative directory based on the product module.

OUTPUT pcSCMRelativeDirectory AS CHARACTER

The calculated SCM relative directory based on the product module. If an SCM tool is being used and SCM checks are in place, the relative path information is retrieved from the currently used SCM tool.

OUTPUT pcFullPathName AS CHARACTER

The calculated full pathname for creating or accessing physical files. The full path does not include the object name. It includes the root directory and either the relative path from the SCM tool if this is valid or the relative directory from the gsc_product_module table.

OUTPUT pcOutputObjectName AS CHARACTER

The validated object name. If the object exists, this returns the repository name of the object, ryc_smartobject.object_filename, in the Repository. If the object does not exist, this parameter contains the pcObjectname value without any relative path information.

OUTPUT pcFileName AS CHARACTER

The calculated physical filename based on the used input parameters. This can be used to create or access the physical filenames of the object being parsed or the associated file for the object.

OUTPUT pcError AS CHARACTER

Any errors encountered during processing that must be returned, such as invalid pcObjectobj values.

Notes: The pcObjectType parameter is not used currently. It is included to allow for future development needs.

Examples: See the getClientCacheDir procedure in ry\app\ryrepmngrp.i.